Update flow framework additional fields in previous_node_inputs #8233
Conversation
yuye-aws
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
|
@dbwiddis Can you also take a look? |
There was a problem hiding this comment.
We need to have all of these descriptions very similar in what they say. I don't think we need to explicitly list when they are already included as required inputs shown on the workflow step API, so the current model ID phrase as "input for several steps" is appropriate.
What needs to be called out here is unusual things:
- the
llm.mode_idvs.model_iddifference (already there) - the inclusion of all 3 of these in the
parameterskey for tools (not yet here)
| |-----------------|--- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `model_id` |String | The `model_id` is used as an input for several steps. As a special case for the Register Agent step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | | ||
| | `agent_id` |String | The `agend_id` is used as an input for `delete_agent` and `create_tool` step. | | ||
| | `connector_id` |String | The `connector_id` is used as an input for `delete_connector`, `register_remote_model` and `create_tool` steps. | |
There was a problem hiding this comment.
I think there's a key difference here. For register remote model and delete connector, the connector ID is explicitly listed as a required input which would show up with the workflow steps API, and I don't think that needs explicit documentation (other than a similar line as we have for model ID). For the create tool, it's included as part of the parameters, and this I think is the important point that needs to be called out here.
There was a problem hiding this comment.
I see. I need to explicitly show the create_tool type for connector_id is only used for connector tool.
Signed-off-by: yuye-aws <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
yuye-aws
force-pushed
the
flow_framework_connector_id
branch
from
30df765
to
58fbb28
Compare
| |`model_id` |String |The `model_id` is used as an input for several steps. As a special case for the Register Agent step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | | ||
| | Field |Data type | Description | | ||
| |-----------------|--- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `model_id` |String | The `model_id` is used as an input for `delete_model`, `deploy_model`, `undeploy_model`, `register_agent` and `create_tool` step. As a special case for the `register_agent` step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | |
There was a problem hiding this comment.
This is still missing the fact that for create_tool, it's part of the parameters input.
That's really the essential information you're adding with this documentation update but it's not obvious to me and I've looked at the code.
I really don't think you need to list every step that it's a required input for; those are included in the API already. The previous line "several steps" is fine, perhaps adding a reference to using that workflow step API.
Please focus the new content on what is not clearly identified by the existing API.
Signed-off-by: yuye-aws <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
| |`model_id` |String |The `model_id` is used as an input for several steps. As a special case for the Register Agent step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | | ||
| | Field |Data type | Description | | ||
| |-----------------|--- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `model_id` |String | The `model_id` is used as an input for several steps. As a special case for the `register_agent` step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | |
There was a problem hiding this comment.
| | `model_id` |String | The `model_id` is used as an input for several steps. As a special case for the `register_agent` step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | | |
| | `model_id` |String | The `model_id` is used as an input for several steps. As a special case for the `register_agent` step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. The `model_id` will also be included in the `parameters` input of the `create_tool` step. | |
I would prefer this (repeat for the other two) rather than a separate "note".
Co-authored-by: Daniel Widdis <[email protected]> Signed-off-by: yuye-aws <[email protected]>
Signed-off-by: yuye-aws <[email protected]>
dbwiddis
added
4 - Doc review
kolchfa-aws
added
the
release-notes
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: yuye-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: yuye-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: yuye-aws <[email protected]>
There was a problem hiding this comment.
@yuye-aws @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
| |--- |--- |--- | | ||
| |`model_id` |String |The `model_id` is used as an input for several steps. As a special case for the Register Agent step type, if an `llm.model_id` field is not present in the `user_inputs` and not present in `previous_node_inputs`, the `model_id` field from the previous node may be used as a backup for the model ID. | | ||
| | Field |Data type | Description | | ||
| |-----------------|--- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
There was a problem hiding this comment.
Below: "As a special case" reads a bit awkwardly/ambiguously. Can it be removed/rephrased?
There was a problem hiding this comment.
Updated with a note below.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: yuye-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: yuye-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: yuye-aws <[email protected]>
…search-project#8233) * update: flow framework previous node inputs Signed-off-by: yuye-aws <[email protected]> * update typo Signed-off-by: yuye-aws <[email protected]> * update model id step input types Signed-off-by: yuye-aws <[email protected]> * update create_tool note Signed-off-by: yuye-aws <[email protected]> * reduce redundant step types Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: Daniel Widdis <[email protected]> Signed-off-by: yuye-aws <[email protected]> * optimize doc Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: yuye-aws <[email protected]> * Update _automating-configurations/workflow-steps.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> Co-authored-by: Daniel Widdis <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
Description
Flow framework supports parse connector_id and agent_id from previous steps when create tools.
Issues Resolved
Closes #8232
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Since 2.17.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.